<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxBatchQueryResult&lt; HitType &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structPxBatchQueryResult.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structPxBatchQueryResult-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PxBatchQueryResult&lt; HitType &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group__physics.html">Physics</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Generic struct for receiving results of single query in a batch. Gets templated on hit type <a class="el" href="structPxRaycastHit.html" title="Stores results of raycast queries. ">PxRaycastHit</a>, <a class="el" href="structPxSweepHit.html" title="Stores results of sweep queries. ">PxSweepHit</a> or <a class="el" href="structPxOverlapHit.html" title="Stores results of overlap queries. ">PxOverlapHit</a>.  
 <a href="structPxBatchQueryResult.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="PxBatchQueryDesc_8h_source.html">PxBatchQueryDesc.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for PxBatchQueryResult&lt; HitType &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structPxBatchQueryResult__coll__graph.png" border="0" usemap="#PxBatchQueryResult_3_01HitType_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="PxBatchQueryResult_3_01HitType_01_4_coll__map" id="PxBatchQueryResult_3_01HitType_01_4_coll__map">
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:adff3cbaeaa46db9a605847696e1f8d13"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBatchQueryResult.html#adff3cbaeaa46db9a605847696e1f8d13">getNbAnyHits</a> () const</td></tr>
<tr class="memdesc:adff3cbaeaa46db9a605847696e1f8d13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the number of any hits in this result, blocking or touching.  <a href="#adff3cbaeaa46db9a605847696e1f8d13">More...</a><br /></td></tr>
<tr class="separator:adff3cbaeaa46db9a605847696e1f8d13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac73375fe0f926f910c037fdcd5f0d785"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> const HitType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBatchQueryResult.html#ac73375fe0f926f910c037fdcd5f0d785">getAnyHit</a> (const <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> index) const</td></tr>
<tr class="memdesc:ac73375fe0f926f910c037fdcd5f0d785"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience iterator used to access any hits in this result, blocking or touching.  <a href="#ac73375fe0f926f910c037fdcd5f0d785">More...</a><br /></td></tr>
<tr class="separator:ac73375fe0f926f910c037fdcd5f0d785"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aa91f15d629285e2471fcbb039af1d17b"><td class="memItemLeft" align="right" valign="top">HitType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBatchQueryResult.html#aa91f15d629285e2471fcbb039af1d17b">block</a></td></tr>
<tr class="memdesc:aa91f15d629285e2471fcbb039af1d17b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds the closest blocking hit for a single query in a batch. Only valid if hasBlock is true.  <a href="#aa91f15d629285e2471fcbb039af1d17b">More...</a><br /></td></tr>
<tr class="separator:aa91f15d629285e2471fcbb039af1d17b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b4cabd4f1a5befef4a55048854d1a68"><td class="memItemLeft" align="right" valign="top">HitType *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBatchQueryResult.html#a4b4cabd4f1a5befef4a55048854d1a68">touches</a></td></tr>
<tr class="separator:a4b4cabd4f1a5befef4a55048854d1a68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac884d117477c6f480d9ceb53d229ead"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBatchQueryResult.html#aac884d117477c6f480d9ceb53d229ead">nbTouches</a></td></tr>
<tr class="memdesc:aac884d117477c6f480d9ceb53d229ead"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of touching hits returned by this query, works in tandem with touches pointer.  <a href="#aac884d117477c6f480d9ceb53d229ead">More...</a><br /></td></tr>
<tr class="separator:aac884d117477c6f480d9ceb53d229ead"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fc4664be9c55e563e5ba65b0071ee89"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBatchQueryResult.html#a1fc4664be9c55e563e5ba65b0071ee89">userData</a></td></tr>
<tr class="memdesc:a1fc4664be9c55e563e5ba65b0071ee89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy of the userData pointer specified in the corresponding query.  <a href="#a1fc4664be9c55e563e5ba65b0071ee89">More...</a><br /></td></tr>
<tr class="separator:a1fc4664be9c55e563e5ba65b0071ee89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb01163e07196e8a4867f4b5d4c8752d"><td class="memItemLeft" align="right" valign="top">PxU8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBatchQueryResult.html#adb01163e07196e8a4867f4b5d4c8752d">queryStatus</a></td></tr>
<tr class="memdesc:adb01163e07196e8a4867f4b5d4c8752d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Takes on values from <a class="el" href="structPxBatchQueryStatus.html#a65079b6fb3edafc98c6101bd6bc9b306">PxBatchQueryStatus::Enum</a>.  <a href="#adb01163e07196e8a4867f4b5d4c8752d">More...</a><br /></td></tr>
<tr class="separator:adb01163e07196e8a4867f4b5d4c8752d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35efe4f4170d5b2ee88a42f1618644d4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBatchQueryResult.html#a35efe4f4170d5b2ee88a42f1618644d4">hasBlock</a></td></tr>
<tr class="memdesc:a35efe4f4170d5b2ee88a42f1618644d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if there was a blocking hit.  <a href="#a35efe4f4170d5b2ee88a42f1618644d4">More...</a><br /></td></tr>
<tr class="separator:a35efe4f4170d5b2ee88a42f1618644d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0b4a79dc77732dc7bbe5c56f50bd4a6"><td class="memItemLeft" align="right" valign="top">PxU16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBatchQueryResult.html#ad0b4a79dc77732dc7bbe5c56f50bd4a6">pad</a></td></tr>
<tr class="memdesc:ad0b4a79dc77732dc7bbe5c56f50bd4a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">pads the struct to 16 bytes.  <a href="#ad0b4a79dc77732dc7bbe5c56f50bd4a6">More...</a><br /></td></tr>
<tr class="separator:ad0b4a79dc77732dc7bbe5c56f50bd4a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename HitType&gt;<br />
struct PxBatchQueryResult&lt; HitType &gt;</h3>

<p>Generic struct for receiving results of single query in a batch. Gets templated on hit type <a class="el" href="structPxRaycastHit.html" title="Stores results of raycast queries. ">PxRaycastHit</a>, <a class="el" href="structPxSweepHit.html" title="Stores results of sweep queries. ">PxSweepHit</a> or <a class="el" href="structPxOverlapHit.html" title="Stores results of overlap queries. ">PxOverlapHit</a>. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000006">Deprecated:</a></b></dt><dd>The batched query feature has been deprecated in PhysX version 3.4 </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ac73375fe0f926f910c037fdcd5f0d785"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac73375fe0f926f910c037fdcd5f0d785">&#9670;&nbsp;</a></span>getAnyHit()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> const HitType&amp; <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::getAnyHit </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td>
          <td class="paramname"><em>index</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Convenience iterator used to access any hits in this result, blocking or touching. </p>

<p class="reference">References <a class="el" href="group__foundation.html#ga4a83a657390b324a460f14684e5accee">PX_ASSERT</a>.</p>

</div>
</div>
<a id="adff3cbaeaa46db9a605847696e1f8d13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adff3cbaeaa46db9a605847696e1f8d13">&#9670;&nbsp;</a></span>getNbAnyHits()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::getNbAnyHits </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Computes the number of any hits in this result, blocking or touching. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aa91f15d629285e2471fcbb039af1d17b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa91f15d629285e2471fcbb039af1d17b">&#9670;&nbsp;</a></span>block</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">HitType <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::block</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Holds the closest blocking hit for a single query in a batch. Only valid if hasBlock is true. </p>

</div>
</div>
<a id="a35efe4f4170d5b2ee88a42f1618644d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35efe4f4170d5b2ee88a42f1618644d4">&#9670;&nbsp;</a></span>hasBlock</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::hasBlock</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>True if there was a blocking hit. </p>

</div>
</div>
<a id="aac884d117477c6f480d9ceb53d229ead"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac884d117477c6f480d9ceb53d229ead">&#9670;&nbsp;</a></span>nbTouches</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::nbTouches</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of touching hits returned by this query, works in tandem with touches pointer. </p>

</div>
</div>
<a id="ad0b4a79dc77732dc7bbe5c56f50bd4a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0b4a79dc77732dc7bbe5c56f50bd4a6">&#9670;&nbsp;</a></span>pad</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">PxU16 <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::pad</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>pads the struct to 16 bytes. </p>

</div>
</div>
<a id="adb01163e07196e8a4867f4b5d4c8752d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb01163e07196e8a4867f4b5d4c8752d">&#9670;&nbsp;</a></span>queryStatus</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">PxU8 <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::queryStatus</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Takes on values from <a class="el" href="structPxBatchQueryStatus.html#a65079b6fb3edafc98c6101bd6bc9b306">PxBatchQueryStatus::Enum</a>. </p>

</div>
</div>
<a id="a4b4cabd4f1a5befef4a55048854d1a68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b4cabd4f1a5befef4a55048854d1a68">&#9670;&nbsp;</a></span>touches</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">HitType* <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::touches</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This pointer will either be set to NULL for 0 nbTouches or will point into the user provided batch query results buffer specified in <a class="el" href="classPxBatchQueryDesc.html" title="Descriptor class for PxBatchQuery. ">PxBatchQueryDesc</a>. </p>

</div>
</div>
<a id="a1fc4664be9c55e563e5ba65b0071ee89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1fc4664be9c55e563e5ba65b0071ee89">&#9670;&nbsp;</a></span>userData</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename HitType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void* <a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a>&lt; HitType &gt;::userData</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Copy of the userData pointer specified in the corresponding query. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="PxBatchQueryDesc_8h_source.html">PxBatchQueryDesc.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structPxBatchQueryResult.html">PxBatchQueryResult</a></li>
    <li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
  </ul>
</div>
</body>
</html>
